docs: add ADR-0001 for two-contract split (Registry + Agents) - #921
Open
solaoye187-lab wants to merge 1 commit into
Open
docs: add ADR-0001 for two-contract split (Registry + Agents)#921solaoye187-lab wants to merge 1 commit into
solaoye187-lab wants to merge 1 commit into
Conversation
Document the rationale, alternatives considered, cross-contract call cost, deployment ordering constraints, type duplication risks, and conditions under which the contracts should be merged. Link from architecture.md so the decision is discoverable.
|
@solaoye187-lab Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #828
Document Soroban Contract Split
Summary
Add an ADR documenting why the registry and agents Soroban contracts are split, the trade-offs of the architecture, and the conditions under which they could be merged.
Changes
Add an ADR under docs/adr/.
Document alternatives and architectural trade-offs.
Document the cost and implications of the cross-contract call.
Document deployment ordering and independent upgradeability.
Link the ADR from docs/architecture.md.
Define what would need to be true before merging the contracts.
Acceptance Criteria
ADR is committed under docs/adr/.
Trade-offs and alternatives are covered.
ADR is linked from the architecture documentation.
The conditions for safely merging the contracts are documented.
Before Starting
Comment on the issue/thread to claim this work and avoid duplicate efforts. If the proposed approach seems incorrect, raise it in the thread before proceeding.